home *** CD-ROM | disk | FTP | other *** search
/ Aminet 4 / Aminet 4 - November 1994.iso / aminet / comm / bbs / str_utilities3.lha / str.utils / docs / STR.Top10.doc < prev   
Text File  |  1994-08-25  |  13KB  |  354 lines
  1.  
  2.                         The ST/R Utilities Package
  3.                                  Release 3
  4.  
  5.                                     By:
  6.  
  7.                             Douglas McLaughlin
  8.                                [Black Fire]
  9.  
  10. * All new or updated information since the last release will have a star in
  11.   the left column.
  12.  
  13. ------------------------------------------------------------------------------
  14.  
  15.                               STR.Top10.rexx
  16.                               STR.Graph.rexx
  17.  
  18.  
  19. INSTALLATION:
  20.  
  21.  
  22.   File Locations:
  23.  
  24.     STR.Top10.rexx ---> Doors:STR.Utils/
  25.     STR.Graph.rexx ---> Doors:STR.Utils/
  26.  
  27.   Install in the BBS:
  28.  
  29.     To install STR.Top10.rexx, create or add the following line to your
  30.     "TEXT.WELCOME.USER" file in the BBS:TEXT/ENGLISH/ directory:
  31.  
  32. \#0Doors:STR.Utils/STR.Top10.rexx\
  33.  
  34.     Also, add the following to the END of line 1636 of the "English" file
  35.     in the BBS:Languages/ directory:
  36.  
  37. \#0Doors:STR.Utils/STR.Top10.rexx\
  38.  
  39.     STR.Graph.rexx is automatically called by STR.Top10.rexx.  See the
  40.     Configuration section for an alternate installation.
  41.  
  42.     If you set the graphnow varible in STR.Top10.rexx to 0 then add the
  43.     following line to the END of either the "TEXT.WELCOME.USER" or the
  44.     "TEXT.LOGOUT" files in the BBS:TEXT/ENGLISH/ directory:
  45.  
  46. \$0Run Rx Doors:STR.Utils/STR.Graph.rexx\
  47.  
  48.   Test Mode Installation:
  49.  
  50.     To test the display of the CPS graphics you can install the STR.Top10.rexx
  51.     program as a door program.  To ensure this works correctly, only sysop
  52.     access should be given AND part of the description *MUST* include
  53.     "STR.Top10".  This is case-sensitive so you must use both upper and lower
  54.     case exactly as shown.  To test other graphic modes, use the TS command
  55.     to change your graphic's setting.
  56.  
  57.   Alternate Installation:
  58.  
  59.     You can also add the following configuration to the STR.LogOn.Mcfg file
  60.     instead of the above mentioned entry in the "TEXT.WELCOME.USER" file.
  61.  
  62. The Statistics Compiler
  63. \#0Doors:STR.Utils/STR.Top10.rexx\
  64. 4
  65.  
  66.  
  67. REQUIREMENTS:
  68.  
  69.  
  70.   Any Amiga ;)
  71.  
  72.     The faster the better! =)
  73.  
  74.   OS 2.04+
  75.  
  76.     The AmigaDOS SORT command should be in C: or available in your PATH.
  77.     The AmigaDOS COPY command should be in C: or available in your PATH.
  78.     Untested with, but should work fine with, OS 3.0/3.1
  79.  
  80.   ARexx:
  81.   
  82.     RexxMast should be run in your s:user-startup.
  83.     rexxsupport.library should be installed in Libs:
  84.   
  85.   Excelsior! BBS v1.20+
  86.  
  87.     Works fine with v1.21 as well.
  88.  
  89.   Assignment to T:
  90.   
  91.     Preferably to RAM:T/ but can be anywhere.
  92.  
  93.  
  94. KNOWN BUGS:
  95.  
  96.  
  97.   If a new user completely logs on but drops carrier, that user's "number of
  98.   calls" variable isn't updated.  What this means is that when the user
  99.   called back s/he would show up in the new users list a second time, except
  100.   there is a line of code that prevents this from happening.  In previous
  101.   versions, this made the list grow shorter from time to time.  With this
  102.   version, the list graph itself will always be the same size, but the number
  103.   of users in the list will vary.  Under the previous versions, the list
  104.   would never grow longer, now it will increase in size back up to the topnum
  105.   varibles amount.  This, of course, depends on how your new users log off!
  106.  
  107. * If there are less than 10 people in the STR.Top10.data file, AND one or
  108. * more of them is already on your Gods list, AND one or more of the others
  109. * have never uploaded or downloaded, THEN blank lines will show up in
  110. * either the BytesDown or FilesDown lists.  Once any one of the above three
  111. * cases is changed, the lines will go away.  This will be fixed in a future
  112. * release, but it is not an urgent matter. ;)
  113.  
  114. *   Reported By:  Stace Cunningham @ 1:3604/60.0
  115.  
  116.  
  117. CONFIGURATION:
  118.  
  119.  
  120.   STR.Top10.rexx
  121.  
  122.     datapath - Set this to the path where STR.Top10.rexx can store its data.
  123.  
  124.     sysop    - Access levels above this don't get logged.
  125.  
  126.     maxdays  - Delete a user from the Top10 lists after this many days of
  127.                inactivity.
  128.  
  129.     maxcday  - Delete a user from the TopCPS lists after this many days of
  130.                inactivity.
  131.  
  132.     topnum   - Maximum number of items per each Top10 list.
  133.  
  134.     xtratime - Extra time given to a user if the user breaks the current
  135.                high CPS at the current baud rate.
  136.  
  137.     realname - If you set this to 1 then all output/text files will use the
  138.                user's real name.  Set this to 0 and all output/text files
  139.                will use the user's alias.
  140.  
  141.     graphnow - If you set this to 1 then STR.Top10.rexx will automatically
  142.                run STR.Graph.rexx synchroniously.  The user will be sent a
  143.                message before each Top10 list or graph is made that updates
  144.                the programs progress.  If you set this to 0, it is your
  145.                responsibitly to see that the STR.Graph.rexx program gets
  146.                executed.  It is suggested either at the end of the
  147.                "TEXT.WELCOME.USER" file or at the end of the "TEXT.LOGOUT"
  148.                file, both in the BBS:TEXT/ENGLISH/ directory.
  149.  
  150.     comment. - These 18 lines are the various comments given for a certain
  151.                percent of the baud rate.  At 14,400 a download that is close
  152.                to 1440 CPS will give comment 10.
  153.  
  154.   STR.Graph.rexx
  155.  
  156.     datapath  - Set this to the path where STR.Graph.rexx can find its data.
  157.  
  158.     maxtopnum - Maximum number of items per each Top10 list.
  159.                 (Yeah, I know.  I used a different variable name ;)
  160.  
  161.     topfiledn - Users who download this many files, or more, will be on the
  162.                 God's list of donwloaders.
  163.  
  164.     topfileup - Users who upload this many files, or more, will be on the
  165.                 God's list of uploaders.
  166.  
  167.     topbytedn - Users who download this many bytes, or more, will be on the
  168.                 God's list of donwloaders.
  169.  
  170.     topbyteup - Users who upload this many bytes, or more, will be on the
  171.                 God's list of uploaders.
  172.  
  173.  
  174. PURPOSE & FEATURES:
  175.  
  176.  
  177.   STR.Top10.rexx
  178.  
  179.     This program has a two-fold purpose depending upon the environment in
  180.     which it is executed.  If executed in your TEXT.WELCOME.USER file the
  181.     program collects information about the user currently logging on and
  182.     saves it in structured data files for later retrieval by the
  183.     STR.Graph.rexx program.  If executed from the English file after an
  184.     upload or download, the program will collect information about the
  185.     file transfer and save it for the STR.Graph.rexx progrm.  It will also
  186.     display giant ANSI numbers of the user's CPS and rank the user against
  187.     other callers at the same baud rate.  If the program is executed as a
  188.     door, it chooses a random number between 1000 and 2000 for a CPS speed,
  189.     then calls the ANSI display routine.
  190.  
  191.     This program has the option of automatically calling the STR.Graph.rexx
  192.     program.  This is up to each individual sysop; however, it will most
  193.     likely depend upon the speed of the system on which the BBS is running.
  194.     If both programs are run, the user will be able to how s/he ranks against
  195.     other callers immediately.  If not, the user will only be able to see
  196.     information from the preceding call.
  197.  
  198.   STR.Graph.rexx
  199.  
  200.     This program uses the information gathered by STR.Top10.rexx to create
  201.     several Top10 lists or Activity Graphs.  The graphs of the baud rates
  202.     and usage per hour are very nice and provide a lot of information.  The
  203.     Hour Usage chart *WON'T* "go flat" after a few weeks like Master's
  204.     Statistics window does, or OTHER Hour "Usage" charts that I've seen.
  205.     This program can be run from the CLI/Shell as well.
  206.  
  207.     This program has the nasty habit of being slow.  I suspect most 68000
  208.     based systems will run this program asynchroniously.
  209.  
  210.     The files produced by STR.Graph.rexx are located in the BBS:TBASE/
  211.     directory.  The files are as follows:
  212.  
  213.       STR.LastCallers - Shows the user's name or alias, total calls, total
  214.                         messages, total bytes up/downloaded, time called,
  215.                         and the baud rate of the call.
  216.  
  217.       STR.NewCallers  - Shows the user's name or alias, city and state, call
  218.                         date and time, and the baud rate of the call.
  219.  
  220.       STR.TopCallers  - Shows the user's name or alias and ranked by total
  221.                         calls.  Also shows the user's name or alias and
  222.                         ranked by total messages posted to the system.
  223.  
  224.       STR.BytesDown   - Shows two lists, one ranked by total bytes downloaded,
  225.                         the other ranked by total bytes uploaded.
  226.  
  227.       STR.GodsBytes   - Shows two lists, one ranked by total bytes downloaded,
  228.                         the other ranked by total bytes uploaded.  Only users
  229.                         whose stats are higher than those set by the topbytedn
  230.                         and topbyteup variables will be on this list.
  231.  
  232.       STR.FilesDown   - Shows two lists, one ranked by total files downloaded,
  233.                         the other ranked by total files uploaded.
  234.  
  235.       STR.GodsBytes   - Shows two lists, one ranked by total files downloaded,
  236.                         the other ranked by total files uploaded.  Only users
  237.                         whose stats are higher than those set by the topfiledn
  238.                         and topfileup variables will be on this list.
  239.  
  240. *     STR.CPSRates    - Shows user's name or alias, date, baud rate, cps rate,
  241.                         and cps percentage of the fastest up/downloaders on
  242.                         your system.
  243.  
  244.       STR.BaudGraph   - This is a horizontal graph showing each baud rate.
  245.                         The number in the end of the graph is a percent of
  246.                         the total calls at this baud rate.  The number in
  247.                         brackets is the total number of calls at this baud
  248.                         rate.  The number in the lower right corner of the
  249.                         graph is the total number of calls in the graph.
  250.  
  251.       STR.HourGraph   - This is a vertical graph showing all 24 hours from 00
  252.                         to 23.  The numbers on the left side of the graph are
  253.                         percentages based on the hour with the highest percent
  254.                         of calls.  The number in the top of each bar is the
  255.                         actual percent for that hour.  The number on top of
  256.                         each bar is the total number of calls for that hour.
  257.                         The number in the top left part of the graph is the
  258.                         total number of calls in the graph.
  259.  
  260.  
  261. HISTORY:
  262.  
  263.  
  264. * Version 1.07:
  265.  
  266.     STR.Top10.rexx
  267.  
  268.       Made some more cosmetic changes to the CPS display.
  269.  
  270.   Version 1.06:
  271.  
  272.     STR.Top10.rexx
  273.  
  274.       Completely re-wrote the routines that updates the data for the last
  275.       callers and new callers lists.  They make sense now.
  276.  
  277.       Another cosmetic change made to the CPS display.
  278.  
  279. *   STR.Graph.rexx
  280.  
  281.       Made a change to the IPL sequence in the Hour and Baud graphs so that
  282.       they display correctly on an IBM terminal.
  283.  
  284. * Version 1.05:
  285.  
  286.     STR.Graph.rexx
  287.  
  288.       Added STR.CPSRates as one of the top lists produced.
  289.  
  290.   Version 1.04:
  291.  
  292.     STR.Top10.rexx
  293.  
  294.       Fixed a bug induced by swapping the user's name and alias.  A user
  295.       would show up twice in the Top10.data file, once under the real name
  296.       and once under the alias.  This is now eliminated.
  297.  
  298.   Version 1.03:
  299.  
  300.     STR.Top10.rexx
  301.  
  302.       Added the variable realname to the configuration section.  This
  303.       switches the user's alias and real name.  This makes no change to
  304.       your already existing data files.  If you change this to use alias'
  305.       instead of real names like in the previous version, the old data files
  306.       won't be changed.  This means that new callers will see their alias'
  307.       in the text files, but callers that haven't called since the new
  308.       version will still have their real names displayed.
  309.  
  310.       Suggested By: Stace Cunningham @ 1:3604/60.0
  311.  
  312.   Version 1.02:
  313.  
  314.     STR.Top10.rexx
  315.  
  316.       Changed the format of the STR.Top10.cpsD and .cpsU files so that the
  317.       SORT applies to the baud rate and not to the cps.  This invalidates
  318.       the v1.0 files, so you will have to delete them.  If you want to avoid
  319.       deleteing these files, load them into a text editor and reverse the
  320.       first and third items for all lines in the files.  Each item is
  321.       separated by a (;) semi-colon.
  322.  
  323.       Miscellaneous bugs fixed and cosmetic changes made to the CPS display.
  324.  
  325.     STR.Graph.rexx
  326.  
  327.       Made some changes to the baud rate and hour charts.  Both charts will
  328.       now highlight the current user's baud rate and hour called in a
  329.       different color.
  330.  
  331.       Changed the baud graph so that when a user connects at a strange baud
  332.       rate like 7200 or 4800, etc.  If that baud's percentage is less than
  333.       1%, the graph will not show that baud rate.  However, if the current
  334.       user is at one of these rates, the graph WILL show that baud.
  335.  
  336.   Version 1.0:
  337.  
  338.     First public release.
  339.  
  340.   The Past:
  341.  
  342.     The STR.Top10.rexx program contains some code written by Kenneth Brill.
  343.     Specifically, the code that draws the big ANSI CPS numbers after a
  344.     file transfer.
  345.  
  346.  
  347. FUTURE:
  348.  
  349.  
  350.   STR.Graph.rexx
  351.  
  352.     I plan on adding some kind of graph, similar to the baud graph, for
  353.     each baud rate's top cps up/downloaders.
  354.